<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>EnTech FPK: Thread&lt; Any &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">EnTech FPK
   &#160;<span id="projectnumber">1</span>
   </div>
   <div id="projectbrief">FRC Programming Kit by the EnTech 281 GreenVillains</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_thread_3_01_any_01_4-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Thread&lt; Any &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_thread_8hpp_source.html">Thread.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2cd3360c2f6172a36c9a24286c810ae7"><td class="memTemplParams" colspan="2">template&lt;typename Function &gt; </td></tr>
<tr class="memitem:a2cd3360c2f6172a36c9a24286c810ae7"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#a2cd3360c2f6172a36c9a24286c810ae7">Thread</a> (const std::string &amp;name, Function function)</td></tr>
<tr class="separator:a2cd3360c2f6172a36c9a24286c810ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a150afd8994beeb060708cafacff23474"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#a150afd8994beeb060708cafacff23474">~Thread</a> ()</td></tr>
<tr class="separator:a150afd8994beeb060708cafacff23474"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af759d6a9dee31f5d84008a66e6d61fbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#af759d6a9dee31f5d84008a66e6d61fbe">Start</a> ()</td></tr>
<tr class="separator:af759d6a9dee31f5d84008a66e6d61fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9050a7a4ddcd7e8c07b6989ef3cc3d8"><td class="memTemplParams" colspan="2">template&lt;typename Arg0 &gt; </td></tr>
<tr class="memitem:aa9050a7a4ddcd7e8c07b6989ef3cc3d8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#aa9050a7a4ddcd7e8c07b6989ef3cc3d8">Start</a> (Arg0 arg0)</td></tr>
<tr class="separator:aa9050a7a4ddcd7e8c07b6989ef3cc3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a198c9d72a4cb273e22e9a7f031571033"><td class="memTemplParams" colspan="2">template&lt;typename Arg0 , typename Arg1 &gt; </td></tr>
<tr class="memitem:a198c9d72a4cb273e22e9a7f031571033"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#a198c9d72a4cb273e22e9a7f031571033">Start</a> (Arg0 arg0, Arg1 arg1)</td></tr>
<tr class="separator:a198c9d72a4cb273e22e9a7f031571033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a676bf1202939d29260248d21b90f4507"><td class="memTemplParams" colspan="2">template&lt;typename Arg0 , typename Arg1 , typename Arg2 &gt; </td></tr>
<tr class="memitem:a676bf1202939d29260248d21b90f4507"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_thread_3_01_any_01_4.html#a676bf1202939d29260248d21b90f4507">Start</a> (Arg0 arg0, Arg1 arg1, Arg2 arg2)</td></tr>
<tr class="separator:a676bf1202939d29260248d21b90f4507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefa5b180dfb284f16b942b43cc337ba7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefa5b180dfb284f16b942b43cc337ba7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>GetIsSuspended</b> ()</td></tr>
<tr class="separator:aefa5b180dfb284f16b942b43cc337ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f77bf577cd97782c195fdba8341a0fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f77bf577cd97782c195fdba8341a0fe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Stop</b> ()</td></tr>
<tr class="separator:a7f77bf577cd97782c195fdba8341a0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a006daeefb7a713046b83af7e51c520a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a006daeefb7a713046b83af7e51c520a0"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Suspend</b> ()</td></tr>
<tr class="separator:a006daeefb7a713046b83af7e51c520a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16b8e780a548bce7ac9cf0ccfe2ab2ea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16b8e780a548bce7ac9cf0ccfe2ab2ea"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
<tr class="separator:a16b8e780a548bce7ac9cf0ccfe2ab2ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br/>
class Thread&lt; Any &gt;</h3>

<p>The <a class="el" href="class_thread_3_01_any_01_4.html">Thread&lt;Any&gt;</a> class is an easy to use class that lets you launch a function on a seperate thread.</p>
<p><a class="el" href="struct_any.html">Any</a> function can be taken in the constructor, but you must make sure the argument count and types passed to Start match those of the given function. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2cd3360c2f6172a36c9a24286c810ae7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Function &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::<a class="el" href="class_thread.html">Thread</a> </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Function&#160;</td>
          <td class="paramname"><em>function</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="class_thread_3_01_any_01_4.html">Thread&lt;Any&gt;</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Function</td><td>The type of the function. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the thread. </td></tr>
    <tr><td class="paramname">function</td><td>The function to be run by this <a class="el" href="class_thread.html">Thread</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a150afd8994beeb060708cafacff23474"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::~<a class="el" href="class_thread.html">Thread</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destructor for <a class="el" href="class_thread_3_01_any_01_4.html">Thread&lt;Any&gt;</a>. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af759d6a9dee31f5d84008a66e6d61fbe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::Start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Start the <a class="el" href="class_thread.html">Thread</a>.</p>
<p>This overlaod passes no arguments. </p>

</div>
</div>
<a class="anchor" id="aa9050a7a4ddcd7e8c07b6989ef3cc3d8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Arg0 &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::Start </td>
          <td>(</td>
          <td class="paramtype">Arg0&#160;</td>
          <td class="paramname"><em>arg0</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Start the <a class="el" href="class_thread.html">Thread</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Arg0</td><td>The type of the first argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">arg0</td><td>The first argument. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a198c9d72a4cb273e22e9a7f031571033"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Arg0 , typename Arg1 &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::Start </td>
          <td>(</td>
          <td class="paramtype">Arg0&#160;</td>
          <td class="paramname"><em>arg0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Arg1&#160;</td>
          <td class="paramname"><em>arg1</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Start the <a class="el" href="class_thread.html">Thread</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Arg0</td><td>The type of the first argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
    <tr><td class="paramname">Arg1</td><td>The type of the second argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">arg0</td><td>The first argument. </td></tr>
    <tr><td class="paramname">arg1</td><td>The second argument. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a676bf1202939d29260248d21b90f4507"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Arg0 , typename Arg1 , typename Arg2 &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_thread.html">Thread</a>&lt; <a class="el" href="struct_any.html">Any</a> &gt;::Start </td>
          <td>(</td>
          <td class="paramtype">Arg0&#160;</td>
          <td class="paramname"><em>arg0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Arg1&#160;</td>
          <td class="paramname"><em>arg1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Arg2&#160;</td>
          <td class="paramname"><em>arg2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Start the <a class="el" href="class_thread.html">Thread</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Arg0</td><td>The type of the first argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
    <tr><td class="paramname">Arg1</td><td>The type of the second argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
    <tr><td class="paramname">Arg2</td><td>The type of the third argument. (C++ can infer the correct type automatically if you don't specify.) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">arg0</td><td>The first argument. </td></tr>
    <tr><td class="paramname">arg1</td><td>The second argument. </td></tr>
    <tr><td class="paramname">arg2</td><td>The third argument. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/<a class="el" href="_thread_8hpp_source.html">Thread.hpp</a></li>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/Thread.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 12 2013 16:46:51 for EnTech FPK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
